Skip to main content
PUT
/
rag
/
{config_id}
Update Rag Config
curl --request PUT \
  --url https://rag-prod.studio.lyzr.ai/v3/rag/{config_id}/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "<string>",
  "llm_credential_id": "<string>",
  "embedding_credential_id": "<string>",
  "vector_db_credential_id": "<string>",
  "collection_name": "<string>",
  "llm_model": "<string>",
  "embedding_model": "<string>",
  "vector_store_provider": "<string>",
  "description": "<string>",
  "semantic_data_model": true,
  "meta_data": {}
}
'
{
  "success": true
}

​
Endpoint

PUT /v3/rag/{config_id}/

​
Authentication

API Key (x-api-key) must be included in the header.

​
Path Parameters

NameTypeDescription
config_idstringThe ID of the RAG configuration to update.

​
Request Body

A JSON object containing the updated RAG configuration values.

​
JSON Schema

{
  "user_id": "string",
  "llm_credential_id": "string",
  "embedding_credential_id": "string",
  "vector_db_credential_id": "string",
  "description": "",
  "collection_name": "string",
  "llm_model": "string",
  "embedding_model": "string",
  "vector_store_provider": "string",
  "semantic_data_model": false,
  "meta_data": {}
}

​
Response

{
  "success": true
}

​
Example cURL Request


curl -X PUT "https://rag-dev.test.studio.lyzr.ai/v3/rag/{config_id}/" ^
-H "accept: application/json" ^
-H "content-type: application/json" ^
-H "x-api-key: sk-default-EXAMPLEKEY123" ^
-d "{
  \"user_id\": \"user_123\",
  \"llm_credential_id\": \"llm_cred_abc\",
  \"embedding_credential_id\": \"embed_cred_xyz\",
  \"vector_db_credential_id\": \"vectordb_cred_789\",
  \"description\": \"Updated configuration for search\",
  \"collection_name\": \"my_collection\",
  \"llm_model\": \"gpt-4\",
  \"embedding_model\": \"text-embedding-ada-002\",
  \"vector_store_provider\": \"pinecone\",
  \"semantic_data_model\": true,
  \"meta_data\": {\"source\": \"internal\"}
}"

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
config_id
string
required

Unique identifier for the RAG configuration to update.

Body

application/json
​
user_id
string
required
​
llm_credential_id
string
required
​
embedding_credential_id
string
required
​
vector_db_credential_id
string
required
​
collection_name
string
required
​
llm_model
string
required
​
embedding_model
string
required
​
vector_store_provider
string
required
​
description
string
​
semantic_data_model
boolean
​
meta_data
object

Response

Successful Response

​
success
boolean
Example:

true